<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>colorizer Docs</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>colorizer</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/colorizer.html">colorizer</a></li>
  <li><a href="../modules/colorizer.buffer.html">buffer</a></li>
  <li><strong>color</strong></li>
  <li><a href="../modules/colorizer.matcher.html">matcher</a></li>
  <li><a href="../modules/colorizer.parser.argb_hex.html">parser.argb_hex</a></li>
  <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li>
  <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li>
  <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li>
  <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</a></li>
  <li><a href="../modules/colorizer.sass.html">sass</a></li>
  <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li>
  <li><a href="../modules/colorizer.trie.html">trie</a></li>
  <li><a href="../modules/colorizer.utils.html">utils</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>colorizer.color</code></h1>
<p>Helper color functions</p>
<p>

</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#hsl_to_rgb">hsl_to_rgb (h, s, l)</a></td>
	<td class="summary">Converts an HSL color value to RGB.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#hue_to_rgb">hue_to_rgb (p, q, t)</a></td>
	<td class="summary">Convert hsl colour values to rgb.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#is_bright">is_bright (r, g, b)</a></td>
	<td class="summary">Determine whether to use black or white text.</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "hsl_to_rgb"></a>
    <strong>hsl_to_rgb (h, s, l)</strong>
    </dt>
    <dd>
    Converts an HSL color value to RGB.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">h</span>
         number: Hue
        </li>
        <li><span class="parameter">s</span>
         number: Saturation
        </li>
        <li><span class="parameter">l</span>
         number: Lightness
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        number|nil,number|nil,number|nil
    </ol>




</dd>
    <dt>
    <a name = "hue_to_rgb"></a>
    <strong>hue_to_rgb (p, q, t)</strong>
    </dt>
    <dd>
    Convert hsl colour values to rgb.
 Source: https://gist.github.com/mjackson/5311256


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">p</span>
         number
        </li>
        <li><span class="parameter">q</span>
         number
        </li>
        <li><span class="parameter">t</span>
         number
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        number
    </ol>




</dd>
    <dt>
    <a name = "is_bright"></a>
    <strong>is_bright (r, g, b)</strong>
    </dt>
    <dd>
    Determine whether to use black or white text. </p>

<p> ref: https://stackoverflow.com/a/1855903/837964
 https://stackoverflow.com/questions/596216/formula-to-determine-brightness-of-rgb-color


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">r</span>
         number: Red
        </li>
        <li><span class="parameter">g</span>
         number: Green
        </li>
        <li><span class="parameter">b</span>
         number: Blue
        </li>
    </ul>





</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated - February </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
